<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="MaskEffectInstance,mx.effects.effectClasses.MaskEffectInstance,effectMask,moveEasingFunction,scaleEasingFunction,scaleXFrom,scaleXTo,scaleYFrom,scaleYTo,targetArea,targetVisualBounds,xFrom,xTo,yFrom,yTo,createMaskFunction,showTarget,defaultCreateMask,initMaskEffect,onMoveTweenEnd,onMoveTweenUpdate,onScaleTweenEnd,onScaleTweenUpdate,pause,resume,reverse" name="keywords">
<title>mx.effects.effectClasses.MaskEffectInstance</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'MaskEffectInstance - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?mx/effects/effectClasses/MaskEffectInstance.html&amp;mx/effects/effectClasses/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;MaskEffectInstance</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class MaskEffectInstance"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.effects.effectClasses</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class MaskEffectInstance</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">MaskEffectInstance <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> <a href="../EffectInstance.html">EffectInstance</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Subclasses</td><td><a href="../effectClasses/WipeDownInstance.html">WipeDownInstance</a></td>
</tr>
</table>
<p></p>
  The MaskEffectInstance class is an abstract base class 
  that implements the instance class for 
  the MaskEffect class. 
  <p>Every effect class that is a subclass of the TweenEffect class 
  supports the following events:</p>
  
  <ul>
    <li><code>tweenEnd</code>: Dispatched when the tween effect ends. </li>
  
    <li><code>tweenUpdate</code>: Dispatched every time a TweenEffect 
      class calculates a new value.</li> 
  </ul>
  
  <p>The event object passed to the event listener for these events is of type TweenEvent. 
  The TweenEvent class defines the property <code>value</code>, which contains 
  the tween value calculated by the effect. 
  For the Mask effect, 
  the <code>TweenEvent.value</code> property contains a 4-item Array, where: </p>
  <ul>
    <li>value[0]:Number  The value of the target's <code>x</code> property.</li> 
  
    <li>value[1]:Number  The value of the target's <code>y</code> property.</li>
  
    <li>value[2]:Number  The value of the target's <code>scaleX</code> property.</li>
  
    <li>value[3]:Number  The value of the target's <code>scaleY</code> property.</li>
  </ul>
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../../effects/MaskEffect.html" target="">mx.effects.MaskEffect</a>
<br>
<a href="../../events/TweenEvent.html" target="">mx.events.TweenEvent</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<div class="showHideLinks">
<div class="hideInheritedProperty" id="hideInheritedProperty">
<a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
</div>
<div class="showInheritedProperty" id="showInheritedProperty">
<a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
</div>
</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#className">className</a> : String<div class="summaryTableDescription">
      The name of the effect class, such as <code>"FadeInstance"</code>.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#createMaskFunction">createMaskFunction</a> : Function<div class="summaryTableDescription">
   Function called when the effect creates the mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#duration">duration</a> : Number<div class="summaryTableDescription"> 
      The duration of the effect, in milliseconds.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#effect">effect</a> : <a href="../../effects/IEffect.html">IEffect</a>
<div class="summaryTableDescription">
      The IEffect object that created this IEffectInstance object.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#effectTargetHost">effectTargetHost</a> : <a href="../../effects/IEffectTargetHost.html">IEffectTargetHost</a>
<div class="summaryTableDescription">
      A property that lets you access the target
      list-based control of a data effect.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#hideFocusRing">hideFocusRing</a> : Boolean<div class="summaryTableDescription">
      Determines whether the effect should hide
      the focus ring when starting the effect.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#moveEasingFunction">moveEasingFunction</a> : Function<div class="summaryTableDescription">
   Easing function to use for moving the mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#playheadTime">playheadTime</a> : Number<div class="summaryTableDescription">
      Current position in time of the effect.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#propertyChanges">propertyChanges</a> : <a href="../effectClasses/PropertyChanges.html">PropertyChanges</a>
<div class="summaryTableDescription">
      Specifies the PropertyChanges object containing
      the start and end values for the set of properties
      relevant to the effect's targets.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#repeatCount">repeatCount</a> : int<div class="summaryTableDescription">
      Number of times to repeat the effect.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#repeatDelay">repeatDelay</a> : int<div class="summaryTableDescription">
      Amount of time, in milliseconds,
      to wait before repeating the effect.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#scaleEasingFunction">scaleEasingFunction</a> : Function<div class="summaryTableDescription">
   Easing function to use for scaling the mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#scaleXFrom">scaleXFrom</a> : Number<div class="summaryTableDescription">
   Initial scaleX for mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#scaleXTo">scaleXTo</a> : Number<div class="summaryTableDescription"> 
   Ending scaleX for mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#scaleYFrom">scaleYFrom</a> : Number<div class="summaryTableDescription"> 
   Initial scaleY for mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#scaleYTo">scaleYTo</a> : Number<div class="summaryTableDescription">
   Ending scaleY for mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#showTarget">showTarget</a> : Boolean<div class="summaryTableDescription">
      Specifies that the target component is becoming visible, 
      <code>false</code>, or invisible, <code>true</code>.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#startDelay">startDelay</a> : int<div class="summaryTableDescription">
      Amount of time, in milliseconds,
      to wait before starting the effect.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#suspendBackgroundProcessing">suspendBackgroundProcessing</a> : Boolean<div class="summaryTableDescription">
      If <code>true</code>, blocks all background processing
      while the effect is playing.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#target">target</a> : Object<div class="summaryTableDescription">
      The UIComponent object to which this effect is applied.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#targetArea">targetArea</a> : Rectangle<div class="summaryTableDescription">
   The area where the mask is applied on the target.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../EffectInstance.html#triggerEvent">triggerEvent</a> : Event<div class="summaryTableDescription">
      The event, if any, which triggered the playing of the effect.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#xFrom">xFrom</a> : Number<div class="summaryTableDescription"> 
   Initial position's x coordinate for mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#xTo">xTo</a> : Number<div class="summaryTableDescription"> 
   Destination position's x coordinate for mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#yFrom">yFrom</a> : Number<div class="summaryTableDescription">
   Initial position's y coordinate for mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#yTo">yTo</a> : Number<div class="summaryTableDescription"> 
   Destination position's y coordinate for mask.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
</table>
</div>
<a name="protectedPropertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Properties</div>
<table id="summaryTableProtectedProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#effectMask">effectMask</a> : Shape<div class="summaryTableDescription">
   Contains the effect mask, either the default mask created 
   by the <code>defaultCreateMask()</code> method, 
   or the one specified by the function passed to the 
   <code>createMaskFunction</code> property.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#targetVisualBounds">targetVisualBounds</a> : Rectangle<div class="summaryTableDescription">
   The actual size of the effect target, including any drop shadows.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<div class="showHideLinks">
<div class="hideInheritedMethod" id="hideInheritedMethod">
<a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
</div>
<div class="showInheritedMethod" id="showInheritedMethod">
<a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
</div>
</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#MaskEffectInstance()">MaskEffectInstance</a>(target:Object)</div>
<div class="summaryTableDescription">
   Constructor.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../EffectInstance.html#end()">end</a>():void</div>
<div class="summaryTableDescription">
      Interrupts an effect instance that is currently playing,
      and jumps immediately to the end of the effect.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../EffectInstance.html#finishEffect()">finishEffect</a>():void</div>
<div class="summaryTableDescription">
      Called by the <code>end()</code> method when the effect
      finishes playing.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../EffectInstance.html#finishRepeat()">finishRepeat</a>():void</div>
<div class="summaryTableDescription">
      Called after each iteration of a repeated effect finishes playing.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../EffectInstance.html#initEffect()">initEffect</a>(event:Event):void</div>
<div class="summaryTableDescription">
      This method is called if the effect was triggered by the EffectManager.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#pause()">pause</a>():void</div>
<div class="summaryTableDescription">
   Pauses the effect until you call the <code>resume()</code> method.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../EffectInstance.html#play()">play</a>():void</div>
<div class="summaryTableDescription">
      Plays the effect instance on the target.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#resume()">resume</a>():void</div>
<div class="summaryTableDescription">
   Resumes the effect after it has been paused 
   by a call to the <code>pause()</code> method.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#reverse()">reverse</a>():void</div>
<div class="summaryTableDescription">
   Plays the effect in reverse,
   starting from the current position of the effect.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../EffectInstance.html#startEffect()">startEffect</a>():void</div>
<div class="summaryTableDescription">
      Plays the effect instance on the target after the
      <code>startDelay</code> period has elapsed.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../EffectInstance.html#stop()">stop</a>():void</div>
<div class="summaryTableDescription">
      Stops the effect, leaving the target in its current state.</div>
</td><td class="summaryTableOwnerCol"><a href="../EffectInstance.html">EffectInstance</a></td>
</tr>
</table>
</div>
<a name="protectedMethodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Methods</div>
<table id="summaryTableProtectedMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#defaultCreateMask()">defaultCreateMask</a>(targ:Object, bounds:Rectangle):Shape</div>
<div class="summaryTableDescription">
   Creates the default mask for the effect.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#initMaskEffect()">initMaskEffect</a>():void</div>
<div class="summaryTableDescription">
   Initializes the <code>move</code> and <code>scale</code>
   properties of the effect.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onMoveTweenEnd()">onMoveTweenEnd</a>(value:Object):void</div>
<div class="summaryTableDescription"> 
   Callback method that is called when the x and y position 
   of the mask should be updated by the effect for the last time.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onMoveTweenUpdate()">onMoveTweenUpdate</a>(value:Object):void</div>
<div class="summaryTableDescription"> 
   Callback method that is called when the x and y position 
   of the mask should be updated by the effect.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onScaleTweenEnd()">onScaleTweenEnd</a>(value:Object):void</div>
<div class="summaryTableDescription"> 
   Callback method that is called when the 
   <code>scaleX</code> and <code>scaleY</code> properties 
   of the mask should be updated by the effect for the last time.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onScaleTweenUpdate()">onScaleTweenUpdate</a>(value:Object):void</div>
<div class="summaryTableDescription"> 
   Callback method that is called when the 
   <code>scaleX</code> and <code>scaleY</code> properties 
   of the mask should be updated by the effect.</div>
</td><td class="summaryTableOwnerCol">MaskEffectInstance</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="createMaskFunction"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">createMaskFunction</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>createMaskFunction:Function</code>&nbsp;&nbsp;[read-write]<p>
   Function called when the effect creates the mask.
   The default value is a function that returns a Rectangle
   with the same dimensions as the effect target. 
     </p><p>You can use this property to specify your own callback function to draw the mask. 
   The function must have the following signature:</p>
  
   <pre>
   public function createLargeMask(targ:Object, bounds:Rectangle):Shape {
     var myMask:Shape = new Shape();
     // Create mask.
   
     return myMask;
   }
   </pre>
     <p>You set this property to the name of the function, 
   as the following example shows for the WipeLeft effect:</p>
  
   <pre>
     &lt;mx:WipeLeft id="showWL" createMaskFunction="createLargeMask" showTarget="false"/&gt;</pre>
  <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get createMaskFunction():Function</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set createMaskFunction(value:Function):void</code>
<br>
</div>
<a name="effectMask"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">effectMask</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected var effectMask:Shape</code><p>
   Contains the effect mask, either the default mask created 
   by the <code>defaultCreateMask()</code> method, 
   or the one specified by the function passed to the 
   <code>createMaskFunction</code> property.
  </p></div>
<a name="moveEasingFunction"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">moveEasingFunction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var moveEasingFunction:Function</code><p>
   Easing function to use for moving the mask.
  </p></div>
<a name="scaleEasingFunction"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scaleEasingFunction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var scaleEasingFunction:Function</code><p>
   Easing function to use for scaling the mask.
  </p></div>
<a name="scaleXFrom"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scaleXFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var scaleXFrom:Number</code><p>
   Initial scaleX for mask.
  </p></div>
<a name="scaleXTo"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scaleXTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var scaleXTo:Number</code><p> 
   Ending scaleX for mask.
  </p></div>
<a name="scaleYFrom"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scaleYFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var scaleYFrom:Number</code><p> 
   Initial scaleY for mask.
  </p></div>
<a name="scaleYTo"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scaleYTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var scaleYTo:Number</code><p>
   Ending scaleY for mask.
  </p></div>
<a name="showTarget"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">showTarget</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>showTarget:Boolean</code>&nbsp;&nbsp;[read-write]<p>
      Specifies that the target component is becoming visible, 
      <code>false</code>, or invisible, <code>true</code>.
     </p><p>The default value is <code>true</code>.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get showTarget():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set showTarget(value:Boolean):void</code>
<br>
</div>
<a name="targetArea"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">targetArea</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var targetArea:Rectangle</code><p>
   The area where the mask is applied on the target.
   The dimensions are relative to the target itself.
   By default, the area is the entire target and is created like this: 
   <code>new Rectangle(0, 0, target.width, target.height);</code>
  </p></div>
<a name="targetVisualBounds"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">targetVisualBounds</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected var targetVisualBounds:Rectangle</code><p>
   The actual size of the effect target, including any drop shadows. 
   Flex calculates the value of this property; you do not have to set it. 
  </p></div>
<a name="xFrom"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">xFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var xFrom:Number</code><p> 
   Initial position's x coordinate for mask.  
  </p></div>
<a name="xTo"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">xTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var xTo:Number</code><p> 
   Destination position's x coordinate for mask.  
  </p></div>
<a name="yFrom"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">yFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var yFrom:Number</code><p>
   Initial position's y coordinate for mask.  
  </p></div>
<a name="yTo"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">yTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var yTo:Number</code><p> 
   Destination position's y coordinate for mask.  
  </p></div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="MaskEffectInstance()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">MaskEffectInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function MaskEffectInstance(target:Object)</code><p>
   Constructor. 
     </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:Object</code> &mdash; The Object to animate with this effect.
  </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="defaultCreateMask()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">defaultCreateMask</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>protected function defaultCreateMask(targ:Object, bounds:Rectangle):Shape</code><p>
   Creates the default mask for the effect.
     </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">targ</span>:Object</code> &mdash; The effect target.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">bounds</span>:Rectangle</code> &mdash; The actual visual bounds of the target which includes drop shadows
   
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Shape</code> &mdash; A Shape object that defines the mask.
  </td>
</tr>
</table>
</div>
<a name="initMaskEffect()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">initMaskEffect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function initMaskEffect():void</code><p>
   Initializes the <code>move</code> and <code>scale</code>
   properties of the effect. 
   All subclasses should override this function.
   Flex calls it after the mask has been created,
   but before the tweens are created. 
  </p></div>
<a name="onMoveTweenEnd()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onMoveTweenEnd</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function onMoveTweenEnd(value:Object):void</code><p> 
   Callback method that is called when the x and y position 
   of the mask should be updated by the effect for the last time. 
   You do not call this method directly. 
      This method implements the method of the superclass. 
         </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Object</code> &mdash; Contains the final 
   x and y value for the mask position, where <code>value[0]</code> 
   contains the x position of the mask, 
   and <code>value[1]</code> contains the y position.    
  </td>
</tr>
</table>
</div>
<a name="onMoveTweenUpdate()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onMoveTweenUpdate</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function onMoveTweenUpdate(value:Object):void</code><p> 
   Callback method that is called when the x and y position 
   of the mask should be updated by the effect. 
   You do not call this method directly. 
      This method implements the method of the superclass. 
         </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Object</code> &mdash; Contains an interpolated 
   x and y value for the mask position, where <code>value[0]</code> 
   contains the new x position of the mask, 
   and <code>value[1]</code> contains the new y position.    
  </td>
</tr>
</table>
</div>
<a name="onScaleTweenEnd()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onScaleTweenEnd</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function onScaleTweenEnd(value:Object):void</code><p> 
   Callback method that is called when the 
   <code>scaleX</code> and <code>scaleY</code> properties 
   of the mask should be updated by the effect for the last time. 
   You do not call this method directly. 
      This method implements the method of the superclass. 
         </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Object</code> &mdash; Contains the final 
   <code>scaleX</code> and <code>scaleY</code> value for the mask, 
   where <code>value[0]</code> 
   contains the <code>scaleX</code> value of the mask, 
   and <code>value[1]</code> contains the <code>scaleY</code> value.    
  </td>
</tr>
</table>
</div>
<a name="onScaleTweenUpdate()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onScaleTweenUpdate</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function onScaleTweenUpdate(value:Object):void</code><p> 
   Callback method that is called when the 
   <code>scaleX</code> and <code>scaleY</code> properties 
   of the mask should be updated by the effect. 
   You do not call this method directly. 
      This method implements the method of the superclass. 
         </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Object</code> &mdash; Contains an interpolated 
   <code>scaleX</code> and <code>scaleY</code> value for the mask, 
   where <code>value[0]</code> 
   contains the new <code>scaleX</code> value of the mask, 
   and <code>value[1]</code> contains the new <code>scaleY</code> value.    
  </td>
</tr>
</table>
</div>
<a name="pause()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">pause</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public override function pause():void</code><p>
   Pauses the effect until you call the <code>resume()</code> method.
  </p></div>
<a name="resume()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">resume</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public override function resume():void</code><p>
   Resumes the effect after it has been paused 
   by a call to the <code>pause()</code> method. 
  </p></div>
<a name="reverse()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">reverse</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public override function reverse():void</code><p>
   Plays the effect in reverse,
   starting from the current position of the effect.
  </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
